X# contool.info - User interface object help text.
X# This file was generated by `gxv' from `contool.G'.
X# DO NOT EDIT BY HAND.
X#
X:contool_controls
XThe contool control panel has buttons which let you load and store configuration data, adjust contool's configuration, and create and modify message filters. Point at the desired button and press the Help key for more information about that set of
functions.
X#
X:file
XThe File button provides various file-related services to contool users. The associated menu has five entries.
X
X"Load Configuration" brings up the Load Configuration dialog.
X
X"Store Configuration" brings up the Store Configuration dialog.
X
X"Start Logging" starts logging messages to the log file specified in the Properties dialog. If logging is already in effect, this menu item is disabled.
X
X"Stop Logging" stops logging. If logging is not in effect, this menu item is disabled.
X
X"Print" prints the contents of the console use the print filter specified in the Properties dialog.
X
XThe default action is "Load Configuration".
X#
X:view
XThe View button provides three contool support functions:
X
X"Become Console" ensures that contool has the system console attribute. Only one process under SunOS can own the console. If some other process acquires this attribute, messages will no longer be routed to contool. This selection will give the console
attribute back to contool.
X
X"Clear Messages" clears the current console messages from the scrolling display.
X
X"Reset Filter" causes contool to stop processing a multi-line filter. If the user has incorrectly specified the end pattern of a multi-line filter, contool may never stop processing that filter, preventing subsequent messages from being displayed. This
sleection cancels any multi-line fiter in effect. If a multi-line filter is being processed, its starting pattern will be displayed in the left footer of the contool window.
X
XThe default selection is "Become Console".
X#
X:edit
XThe Edit button lets the user edit either the contool properties or the current filter set.
X
XThe "Filters" selection brings up the Filters dialog.
X
XThe "Properties" selection brings up the Properties dialog.
X
XThe default selection is "Filters".
X#
X:display
XThe contool console display contains the text of those messages which contoolhas been configured to display. Some messages may be timestamped. Which messages make it into the console is controlled by the Filters dialog; how many messages are retained is
determined by the Properties dialog.
X#
X:prop_controls
XThe Properties dialog box lets you modify various default attributes of contool. These attributes include how to handle messages which do not match any filter, message logging and printing, and icon images.
X#
X:default_action
XThe Default action setting determines what action contool will take when a message arrives that does not match any filter.
X
XIf "Beep" is selected, the machine bell will be rung the indicated number of times.
X
XIf "Command" is selected, the indicated command will be executed. The contents of the message are written to the command's standard input.
X
XIf "Flash icon" is selected, contool's icon will flash, alternating between the "Check console" and "Flash" images specified in the contool Properties dialog box.
X
XIf "Open window" is selected, contool will open to a window (if iconic) and move in front of any obscuring windows.
X
XIf "Timestamp" is selected, a timestamp will be written to the console before the message text. Timestamping is further controlled by the timestamp resolution defined in the contool Properties dialog box.
X
X#
X:default_beep_count
XThis numeric text field determines the number of times the terminal bell will be rung when a message arrives that does not match any filter.
X
XThis item is only enabled if "Beep" is enabled in the "Default action" setting.
X#
X:default_beep_times
XThis numeric text field determines the number of times the terminal bell will be rung when a message arrives that does not match any filter.
X
XThis item is only enabled if "Beep" is enabled in the "Default action" setting.
X#
X:default_command
XThis text field determines the command that will be exedcuted when a message arrives that does not match any filter. The contents of the message are written to standard input of the executing command.
X
XThis item is only enabled if "Command" is enabled in the "Default action" setting.
X#
X:log_file
XThe Log file text field contains the path of the file to which messages are written if logging is enabled.
X
XMessages are always appended to the file, preserving any previous contents.
X
XTyping a space in this field will cause file name completion to occur, expanding the current pathname to match, as much as possible, any existing files with the same name.
X#
X:log_style
XThe Log messages setting determines whether messages will be written to the log before or after filtering.
X
XIf "Before filtering" is selected, everything received by contool is written to the log.
X
XIf "After filtering" is selected, only those messages that do not match any filter, or that match a filter whose match action is to save the message, are written to the log.
X#
X:print_filter
XThe Print filter text field specifies the command which will be used to print the console when "Print" is selected from the contool "File" menu.
X
XThis command should route its standard input to a printer.
X#
X:good_icon
XThe "All is well" icon text field should contain the path of a file containing the image to be used by contool when it is not flashing its icon. The image should have been produced using iconedit(1).
X
XIf this field is blank, the default icon is used.
X#
X:bad_icon
XThe "Check console" icon text field should contain the path of a file containing the image to be used by contool when it is flashing its icon. The image should have been produced using iconedit(1). The image will be alternated with the "Flash" image to
produce a blinking effect.
X
XIf this field is blank, the default icon is used.
X#
X:flash_icon
XThe "Flash" icon text field should contain the path of a file containing the image to be used by contool when it is flashing its icon. The image should have been produced using iconedit(1). The image will be alternated with the "Check console" image to
produce a blinking effect.
X
XIf this field is blank, the default icon is used.
X#
X:stamp_resolution
XThe Timestamp resolution numeric text item specifies the number of seconds that must elapse before contool will write a new timestamp to the console. Even if a filter requires that a timestamp be written, the stamp will only be inserted if the specified
time has transpired. This keeps the console from becoming clogged with a large number of similar timestamps.
X#
X:message2
XThe Timestamp resolution numeric text item specifies the number of seconds that must elapse before contool will write a new timestamp to the console. Even if a filter requires that a timestamp be written, the stamp will only be inserted if the specified
time has transpired. This keeps the console from becoming clogged with a large number of similar timestamps.
X#
X:max_message
XThe Maximum message text numeric field determines the maximum number of characters contool will keep in the console display. If inserting a new message would exceed this amount, contool will remove text from the beginning fo the display to make room.
The amount of text removed is determined by the "Overflow deletion amount" value.
X#
X:message3
XThe Maximum message text numeric field determines the maximum number of characters contool will keep in the console display. If inserting a new message would exceed this amount, contool will remove text from the beginning fo the display to make room.
The amount of text removed is determined by the "Overflow deletion amount" value.
X#
X:delete_amount
XThe Overflow deletion amount numeric field determines how much text will be removed from the start of the console to make room for a new message whose insertion would cause the console the exceed the "Maximum message text" size.
X
XContool will attempt to remove whole messages from the console in order to retain an orderly appearance.
X#
X:message4
XThe Overflow deletion amount numeric field determines how much text will be removed from the start of the console to make room for a new message whose insertion would cause the console the exceed the "Maximum message text" size.
X
XContool will attempt to remove whole messages from the console in order to retain an orderly appearance.
X#
X:props_apply
XThe Apply button causes the values displayed in the Properties dialog to become the current contool properties. Before Apply is pressed, changes made in this dialog do not affect contool.
X
XEven after pressing Apply, the changes are not written to the contool configuration file. If you wish your changes to remaina cross invocations of contool, use the "Save Configuration" dialog to write the properties to the configuration file.
X#
X:props_reset
XThe Reset button restores the values in the Properties dialog to match the current values in use by contool. Any changes made to these values and not applied to contool are discarded.
X#
X:filter_controls
XThis is the contool filter editing dialog. You use this dialog to add, delete, and modify console message filters.
X#
X:filter_list
XThis scrolling list displays the current contool filter set. Each line corresponds to one filter.
X
XThe starting pattern for each filter is shown in the list, preceded by a small glyph which indicates whether the filter is a single-line or multi-line filter.
X
XTo see the other attributes of a single filter, select that filter with the mouse. The attributes will be displayed in the Filter dialog box.
X
XIf you select more than one filter, the remainder of the dialog box will be grayed out. The dialog box is also disabled if no filter is selected.
X#
X:filter_insert
XThe Insert button inserts a new, blank filter into the filter list. The menu associated with the button allows you to specify where the new filter will be inserted.
X
XThe insert positions are at the top of the list, the bottom of the list, and before or after the current selection. These last choices are only enabled if exactly one filter in the list is selected. The default position is at the bottom of the list.
X
XAfter inserting the new filter, any other selected filters are deselected, and the new filter is selected. You can then define the attributes of this new filter, and update the filter using the Update button.
X#
X:filter_edit
XThe Edit button lets you modify the current filter list. The menu associated with this button provides Cut, Copy, Paste, and Delete operations.
X
XThe Cut operation removes the selected filters from the list and places them on the clipboard. You can place these filters back into the list using the Paste operation.
X
XThe Copy operation places a copy of the selected filters onto the clipboard. The Paste operation will paste the copied filters into the list.
X
XThe Paste operation pastes filters on the clipboard into the filter list. The Paste submenu provides four posting positions: at the top of the list, the bottom of the list, and before or after the current selection. The last two choices are only enabled
if exactly one filter in the list is selected. The default position is at the bottom of the list.
X
XThe Delete operation removes the selected filters from the list. The filters are not placed on the clipboard. Once deleted, filters cannot be recovered with the Paste operation.
X
XThe Cut, Copy, and Delete operations are only enabled when one or more filters in the list are selected. The Paste operation is only enabled after a Cut or Copy operation has placed filters on the clipboard.
X
XThe default edit operation is Cut.
X#
X:filter_update
XThe Update button applies the current filter attributes displayed in the Filters dialog box to the currently selected filter. The only way to modify a filter is to select it, change its attributes, and click the Update button.
X
XThe Update button is only enabled when exactly one filter in the list is selected.
X
XYou must use Update to make changes to a filter take effect. Clciking the Apply button does not perform an Update function on the current filter.
X#
X:filter_type
XThe Type setting determines whether the currently selected filter will match one or several lines of text written to the console.
X
XIf "Single line filter" is selected, the "Pattern" text field is enabled, and must contain a regular expression describing the line of text to be matched by this filter.
X
XIf "Multi-line filter" is selected, both "Pattern" and "End pattern" are enabled. The "Pattern" field should contain a pattern which will match the first line of a multi-line filter. The "End pattern" must match the last line of the multi-line filter.
All text between the first and last lines is considered part of the filtered text.
X#
X:start
XThe Pattern text field contains a regular expression (see ed(1), for more on regular expressions) which will match the first line of a message written to the console. For single line filters, this is the only line matched by the filter. For multi-line
filters, lines of text beginning with the first line and continuing until a line matches the "End pattern" are considered part of the filtered text.
X#
X:stop
XThe End pattern text field contains a regular expression (see ed(1) for more on regular expressions) which will match the last line of a multi-line filter.
X#
X:comment
XThe Comment text field should contain a short description of what the current filter does. Since some filters can be quite arcane, this description can be helpful to new users.
X
XThis field is optional, and can be left empty. Let your conscience be your guide...
X#
X:ignore
XThe When matched selection determines what contool does with a message once it has matched a filter.
X
XIf "Save message" is selected, the actions selected in the "When saved" setting are performed, and the message text is written to the console.
X
XIf "Ignore message" is selected, "When saved" is disabled and the message text is discarded.
X#
X:action
XThe When saved setting determines what action contool will take when a particular filter matches a console message.
X
XIf "Beep" is selected, the machine bell will be rung the indicated number of times.
X
XIf "Command" is selected, the indicated command will be executed. The contents of the message are written to the command's standard input.
X
XIf "Flash icon" is selected, contool's icon will flash, alternating between the "Check console" and "Flash" images specified in the contool Properties dialog box.
X
XIf "Open window" is selected, contool will open to a window (if iconic) and move in front of any obscuring windows.
X
XIf "Timestamp" is selected, a timestamp will be written to the console before the message text. Timestamping is further controlled by the timestamp resolution defined in the contool Properties dialog box.
X
XWhen a new filter is created, the save actions are set to match the default message actions defined in the Properties dialog box.
X#
X:filter_beep_count
XThis numeric text field determines the number of times the terminal bell will be rung when a message arrives matching the current filter.
X
XThis item is only enabled if "When matched" is set to "Save message" and "Beep" is enabled in the "When saved" setting.
X#
X:filter_beep_times
XThis numeric text field determines the number of times the terminal bell will be rung when a message arrives matching the current filter.
X
XThis item is only enabled if "When matched" is set to "Save message" and "Beep" is enabled in the "When saved" setting.
X#
X:filter_command
XThis text field determines the command that will be exedcuted when a message arrives matching the current filter. The contents of the message are written to standard input of the executing command.
X
XThis item is only enabled if "When matched" is set to "Save message" and "Command" is enabled in the "When saved" setting.
X#
X:filters_apply
XThe Apply button takes the set of filters displayed in the filter list and makes them the current contool filter set. Before Apply is pressed, any additions, deletions, or changes made to the filters remain local to the Filters dialog box.
X
XEven after pressing Apply, the filter changes are not written to the configuration file. In roder to make your changes take effect for subsequent invocations of contool, use the Save Configuration dialog box to write them to your configuration file.
X#
X:filters_reset
XThe Reset button discards any changes you have made to the displayed filter set, restoring the filters to match the set currently in use by contool.
X
XChanges made to the filters are local to the Filters dialog box. You can discard your work and start fresh with the existing filter set by pressing the Reset button.
X#
X:load_controls
XThe Load Configuration dialog lets the user load tool properties and/or filter definitions from a configuration file.
X#
X:load_type
XThe Load selection lets the user choose which items are to be loaded from the configuration file.
X
XIf "Tool properties" is selected, contool properties will be loaded from the file.
X
XIf "Filter definitions" is selected, new filters will be loaded from the file, replacing any existing filters.
X#
X:load_file
XThe Configuration file text field must contain the name of the desired configuration file.
X
XTyping a space in this field will cause file name completion to occur, expanding the current pathname to match, as much as possible, any existing files with the same name.
X#
X:accept_load
XThe Load button causes the selected items to be read from the configuration file. Existing properties and/or filters are replaced by those read from the file.
X#
X:store_controls
XThe Store Configuration dialog lets the user store tool properties and/or filter definitions in a configuration file.
X#
X:store_type
XThe Store selection lets the user choose which items are to be stored in the configuration file.
X
XIf "Tool properties" is selected, contool properties will be written to the file.
X
XIf "Filter definitions" is selected, new filters will be written to the file.
X#
X:store_file
XThe Configuration file text field must contain the name of the desired configuration file.
X
XTyping a space in this field will cause file name completion to occur, expanding the current pathname to match, as much as possible, any existing files with the same name.
X#
X:accept_store
XThe Store button writes the desired items to the configuration file. The entire file is overwritten with the data. Thus, a file containing properties and filters will be completely rewritten, even if you only write the filters to it.
END_OF_FILE
if test 18660 -ne `wc -c <'contool.info'`; then
echo shar: \"'contool.info'\" unpacked with wrong size!
fi
# end of 'contool.info'
fi
if test -f 'contool.man' -a "${1}" != "-c" ; then
echo shar: Will not clobber existing file \"'contool.man'\"
